home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxExtOb.BAK < prev    next >
Encoding:
Text File  |  1998-01-28  |  6.5 KB  |  179 lines
  1. //******************************************************************************
  2. //    File: tsxExtOb.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Custom Object
  5. //******************************************************************************
  6.  
  7. #ifndef TSXEXTOB_H
  8. #define TSXEXTOB_H
  9.  
  10.  
  11. #include "tsxTypes.h"
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //    Custom Object
  16. //------------------------------------------------------------------------------
  17.  
  18. // Abstract type for file I/O.
  19. struct TSXAPI tsxFILE{};
  20.  
  21. // Modes for FileIO.
  22. enum tsxFILE_MODE { e_tsxFILE_BINARY = 0, e_tsxFILE_ASCII };
  23.  
  24. // FileIO.
  25. enum tsxFILE_IO { e_tsxFILE_READ = 0, e_tsxFILE_WRITE };
  26.  
  27. // Changes of the object.
  28. enum tsxOBJECT_CHANGE { e_tsxGEOMETRY = 1, e_tsxTOPOLOGY };
  29.  
  30. // FileIO.
  31. enum tsxSELECT { e_tsxUNSELECTED = 0, e_tsxSELECTED };
  32.  
  33. // Flags for ApplyObmove.
  34. #define tsxOMOVE_TRANSLATED    0x0001  /* a translation has been added */
  35. #define tsxOMOVE_ROTATED    0x0002    /* a rotation has been added */
  36. #define tsxOMOVE_SCALED        0x0004  /* a scaling has been added */
  37.  
  38. enum tsxCOLOR_MODE {
  39.  
  40.     e_tsxEDIT_CURPEN = 0,    /* draw whole node leaving pens in current state */
  41.     e_tsxEDIT_ACTIVE,        /* draw whole node in active
  42.                              * foreground color representation */
  43.     e_tsxEDIT_ACTIVESUB,    /* draw whole node in active
  44.                              * subobject foreground color representation */
  45.     e_tsxEDIT_INACTIVE,        /* draw whole node in inactive background color
  46.                              * representation (as partof larger tree) */
  47.     e_tsxEDIT_INACTIVESUB,    /* draw whole node in inactive
  48.                              * subobject color (as part of tree) background
  49.                              * representation */
  50. };
  51.  
  52.  
  53. typedef tsxERR (*tsxObjectDeleteCallbackFP)( tsxSOBJ* pSobj );
  54.         /* to free the object */
  55.  
  56. typedef tsxERR (*tsxObjectCloneSelfCallbackFP)( tsxSOBJ* pSobj, tsxSOBJ* pClone );
  57.         /* make a duplicate of self */
  58.  
  59. typedef tsxERR (*tsxObjectFileIOCallbackFP)( tsxSOBJ* pSobj, tsxFILE *fd, tsxFILE_IO io, tsxFILE_MODE mode );
  60.         /* io function */
  61.  
  62. typedef tsxERR (*tsxObjectRenderCallbackFP)( tsxSOBJ* pSobj, tsxCOLOR_MODE edit, CtsxRect* rect );
  63.         /* draw whole node */
  64. #define tsxERR_CLIPPED    0
  65. #define tsxERR_VISIBLE    1
  66.  
  67. typedef tsxERR (*tsxObjectApplyObmoveCallbackFP)( tsxSOBJ* pSobj, CtsxTxmx3f* trans, unsigned short flags );
  68.         /* apply transformation to object */
  69.  
  70. typedef tsxERR (*tsxObjectScanBCubeCallbackFP)( tsxSOBJ* pSobj, CtsxBBox3f* bc, CtsxTxmx3f* offset );
  71.         /* return minmax for x,y,z for this object when offset by offset (optional) */
  72.  
  73. typedef tsxERR (*tsxObjectRayIntersectCallbackFP)( tsxSOBJ* pSobj, CtsxTxmx3f* torayspace );
  74.         /* Test whether ray intersects object or not. Torayspace is a transform
  75.          * to put world space into rayspace where the ray is XYZ 0,0,1 
  76.          * Returns 0 if no hit 1 if hit, < 0 if error this is used for 
  77.          * object picking */
  78. #define tsxERR_NOHIT    0
  79. #define tsxERR_HIT        1
  80.  
  81. typedef tsxERR (*tsxObjectSelectCallbackFP)( tsxSOBJ* pSobj, tsxSELECT type );
  82.         /* called when object is made or unmade current object */
  83.  
  84. typedef tsxERR (*tsxObjectHasChangedCallbackFP)( tsxSOBJ* pSobj, tsxOBJECT_CHANGE type );
  85.         /* called when parent object is changed and other
  86.          * things need to know right away. */
  87.  
  88. #define tsxVERSION_OBJECT        2
  89.  
  90. typedef struct {
  91.     int version;
  92.     tsxObjectDeleteCallbackFP            extObjectDeleteCB;
  93.     tsxObjectCloneSelfCallbackFP        extObjectCloneSelfCB;
  94.     tsxObjectFileIOCallbackFP            extObjectFileIOCB;
  95.     tsxObjectRenderCallbackFP            extObjectRenderCB;
  96.     tsxObjectApplyObmoveCallbackFP        extObjectApplyObmoveCB;
  97.     tsxObjectScanBCubeCallbackFP        extObjectScanBCubeCB;
  98.     tsxObjectRayIntersectCallbackFP        extObjectRayIntersectCB;
  99.     tsxObjectSelectCallbackFP            extObjectSelectCB;
  100.     tsxObjectHasChangedCallbackFP        extObjectHasChangedCB;
  101. } tsxObjectCallbackFP;
  102.  
  103. // Register an external type of object. Returns the type.
  104. TSXAPIFN tsxSOBJTYPE tsxObjectDefine(
  105.     int tsxid,                            // eXtension id
  106.     char* name,                            // name of the object (max 16 characters)
  107.     tsxObjectCallbackFP* objCallback,    // callback functions for the object
  108.     long objDataLength                    // length of data (may be 0L)
  109.     );
  110.  
  111. // Create an object of the external type .
  112. TSXAPIFN tsxSOBJ* tsxObjectCreate( tsxSOBJTYPE objType );
  113.  
  114. // Get an address of data in the object of the external type.
  115. // Data of objDataLength length are a part of the object.
  116. TSXAPIFN void* tsxObjectGetDataPtr( tsxSOBJ*pSobj );
  117.  
  118. // Get name of object.
  119. TSXAPIFN const char* tsxObjectGetTypeName( tsxSOBJTYPE objType );
  120.  
  121.  
  122. //------------------------------------------------------------------------------
  123. //    Custom Data
  124. //------------------------------------------------------------------------------
  125.  
  126. typedef tsxERR (*tsxDataDeleteCallbackFP)( void* pData );
  127.         /* to free the data */
  128.  
  129. typedef tsxERR (*tsxDataCloneSelfCallbackFP)( void* pData, void* pClone );
  130.         /* make a duplicate of self */
  131.  
  132. typedef tsxERR (*tsxDataFileIOCallbackFP)( void* pData, tsxFILE *fd, tsxFILE_IO io, tsxFILE_MODE mode );
  133.         /* io function */
  134.  
  135. #define tsxVERSION_DATA        2
  136.  
  137. typedef struct {
  138.     int version;
  139.     tsxDataDeleteCallbackFP            extDataDeleteCB;
  140.     tsxDataCloneSelfCallbackFP        extDataCloneSelfCB;
  141.     tsxDataFileIOCallbackFP            extDataFileIOCB;
  142. } tsxDataCallbackFP;
  143.  
  144. typedef int tsxDATATYPE;
  145.  
  146. // Register an external type of data. Returns the type.
  147. tsxDATATYPE tsxDataDefine(
  148.     int tsxid,                            // eXtension id
  149.     char* name,                            // name of the data (max 16 characters)
  150.     tsxDataCallbackFP* dataCallback,    // callback functions for the data
  151.     long dataLength                        // length of data
  152.     );
  153.  
  154. // Add external data to the object.
  155. TSXAPIFN void* tsxSobjCreateData( tsxSOBJ* pSobj, tsxDATATYPE dataType );
  156.  
  157. // Get external data of the object.
  158. TSXAPIFN void* tsxSobjGetData( tsxSOBJ* pSobj, tsxDATATYPE dataType );
  159.  
  160. // Free external data from the object.
  161. TSXAPIFN void tsxSobjDeleteData( tsxSOBJ* pSobj, tsxDATATYPE dataType );
  162.  
  163.  
  164. // I/O functions
  165. TSXAPIFN int tsxFILEerror(tsxFILE *fd);
  166. TSXAPIFN int tsxFILEgetc(tsxFILE *fd);
  167. TSXAPIFN char* tsxFILEgets(char *buf, int size, tsxFILE *fd);
  168. TSXAPIFN int tsxFILEprintf(tsxFILE *fd, const char *fmt,...);
  169. TSXAPIFN int tsxFILEputc(int ch, tsxFILE *fd);
  170. TSXAPIFN int tsxFILEputs(const char *buf, tsxFILE *fd);
  171. TSXAPIFN int tsxFILEread(void *buf, int size, int count, tsxFILE *fd);
  172. TSXAPIFN int tsxFILEscanf(tsxFILE *fd, const char *fmt,...);
  173. TSXAPIFN int tsxFILEseek(tsxFILE *fd, long offset, int where);
  174. TSXAPIFN long tsxFILEtell(tsxFILE *fd);
  175. TSXAPIFN int tsxFILEwrite(const void *buf, int size, int count, tsxFILE *fd);
  176.  
  177. //******************************************************************************
  178. #endif // TSXEXTOB_H
  179.